Overview | Package | Class | Use | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

## rdlc.hw
Class Module

    java.lang.Object
      rdlc.rdl.Declaration_Named
          rdlc.rdl.DynRoot_Standard
              rdlc.hw.Module

All Implemented Interfaces:
  Declaration, DynRoot, Expression

Direct Known Subclasses:
  LibraryModule

    public class Module

extends DynRoot_Standard

Abstracts the details of a hardware module, including input and output wire (port) groups as well as parameter groups. Can include `ModuleWire`, `ModuleParameter`, `ModuleWireGroup`, `ModuleParameterGroup` `ModuleInstance_Indirect`, `ModuleLogic` and `ModuleMux`.

Version:
  $Revision: 1.25 $
Author:
  Greg Gibeling

Nested Class Summary

Nested classes/interfaces inherited from interface rdlc.rdl.Expression
`Expression.Phase`

Field Summary

Fields inherited from class rdlc.rdl.DynRoot_Standard
`instance, isLeaf, isRoot`

Fields inherited from class rdlc.rdl.Declaration_Named
`iName, namespace, rawStaticID`

Constructor Summary
`Module(java.lang.String _name, Namespace _namespace)` Base constructor, creates a module with the given name in the given namespace, but no features.

Method Summary
`boolean` | `connect(ModuleWireGroup target, ModuleWireGroup source)` Connect two wire groups within this module.
`void` | `getRequirements(CatalogSet<Identifier<Declaration>> requirements)` For a dynamic root, we must also take the requirements of it's fields into account.

Methods inherited from class rdlc.rdl.DynRoot_Standard
`getInstance, getLambdaName, isLeaf, isRoot, setNamespace, typeMatch`

Methods inherited from class rdlc.rdl.Declaration_Named
`getBase, getIdentifier, getNamedBase, getRawStaticID, getType, resolve, setRawStaticID, toString`

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait`

Methods inherited from interface rdlc.rdl.Declaration
`getBase, getIdentifier, getNamedBase, getType, setRawStaticID`

Methods inherited from interface rdlc.rdl.Expression
`resolve`

Constructor Detail

### Module

    public Module(java.lang.String _name,
                  Namespace _namespace)

  Base constructor, creates a module with the given name in the given namespace, but no features.

  Parameters:
    `_name` - The name to use for this module.
    `_namespace` - The namespace to create this module in.

Method Detail

### connect

    public boolean connect(ModuleWireGroup target,
                           ModuleWireGroup source)

  Connect two wire groups within this module.

  Parameters:
    `target` - The target wire group.
    `source` - The source wire group.
  Returns:
    `true` on success.

### getRequirements

    public void getRequirements(CatalogSet<Identifier<Declaration>> requirements)

  Description copied from class: `DynRoot_Standard`
  For a dynamic root, we must also take the requirements of it's fields into account.

  Specified by:
    `getRequirements` in interface `Expression`
  Overrides:
    `getRequirements` in class `DynRoot_Standard`
  Parameters:
    `requirements` - A list to which this will add the declarations upon which this one relies.
  See Also:
    `Expression.getRequirements(CatalogSet)`

Overview | Package | Class | Use | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD